Document GdkEventOwnerChange and GdkOwnerChange.

2004-09-14  Matthias Clasen  <mclasen@redhat.com>

	* gdk/tmpl/event_structs.sgml: Document GdkEventOwnerChange and
	GdkOwnerChange.

	* gdk/tmpl/rgb.sgml: Document gdk_rgb_colormap_ditherable().

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 05a03f8f9e0374e4048dcd6bdf16aeadba957efd..082494e10ba46898b2ced4ff76736c7e8b64131c 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,10 @@
+2004-09-14  Matthias Clasen  <mclasen@redhat.com>
+
+       * gdk/tmpl/event_structs.sgml: Document GdkEventOwnerChange and
+       GdkOwnerChange.
+
+       * gdk/tmpl/rgb.sgml: Document gdk_rgb_colormap_ditherable().
+
 2004-09-01  Matthias Clasen  <mclasen@redhat.com>
 
        * gdk/gdk-sections.txt: Updates.

diff --git a/docs/reference/gdk/tmpl/event_structs.sgml b/docs/reference/gdk/tmpl/event_structs.sgml
index 75790c5d01e37f8fc8526f3b710fcb669a29c9ba..cad1ae5541ab912daf3e9d2bcd59acbf717fb815 100644 (file)
--- a/docs/reference/gdk/tmpl/event_structs.sgml
+++ b/docs/reference/gdk/tmpl/event_structs.sgml
@@ -407,17 +407,18 @@ Generated when a setting is modified.
 
 <!-- ##### STRUCT GdkEventOwnerChange ##### -->
 <para>
-
+Generated when the owner of a selection changes. On X11, this information is
+only available if the X server supports the XFIXES extension.
 </para>
 
-@type: 
-@window: 
-@send_event: 
-@owner: 
-@reason: 
-@selection: 
-@time: 
-@selection_time: 
+@type: the type of the event (%GDK_OWNER_CHANGE).
+@window: the window which received the event
+@send_event: %TRUE if the event was sent explicitly (e.g. using <function>XSendEvent</function>).
+@owner: the new owner of the selection
+@reason: the reason for the ownership change as a #GdkOwnerChange value
+@selection: the atom identifying the selection
+@time: the timestamp of the event 
+@selection_time: the time at which the selection ownership was taken over
 
 <!-- ##### ENUM GdkScrollDirection ##### -->
 <para>
@@ -502,10 +503,9 @@ Specifies the kind of modification applied to a setting in a #GdkEventSetting.
 
 <!-- ##### ENUM GdkOwnerChange ##### -->
 <para>
-
+Specifies why a selection ownership was changed.
 </para>
 
-@GDK_OWNER_CHANGE_NEW_OWNER: 
-@GDK_OWNER_CHANGE_DESTROY: 
-@GDK_OWNER_CHANGE_CLOSE: 
-
+@GDK_OWNER_CHANGE_NEW_OWNER: some other app claimed the ownership
+@GDK_OWNER_CHANGE_DESTROY: the window was destroyed
+@GDK_OWNER_CHANGE_CLOSE: the client was closed

diff --git a/docs/reference/gdk/tmpl/rgb.sgml b/docs/reference/gdk/tmpl/rgb.sgml
index 0de80372be6464aa5080b6aeece7ab2f99685e53..22849e1fcb9a6cc2625d3bb5f24a8e808bc6794b 100644 (file)
--- a/docs/reference/gdk/tmpl/rgb.sgml
+++ b/docs/reference/gdk/tmpl/rgb.sgml
@@ -433,13 +433,25 @@ visual should be used when creating windows that will be drawn in by GdkRGB.
 
 <!-- ##### FUNCTION gdk_rgb_ditherable ##### -->
 <para>
-Determines whether the visual is ditherable. This function may be
+Determines whether the preferred visual is ditherable. This function may be
 useful for presenting a user interface choice to the user about which
 dither mode is desired; if the display is not ditherable, it may make
 sense to gray out or hide the corresponding UI widget.
 </para>
 
-@Returns: %TRUE if the visual is ditherable.
+@Returns: %TRUE if the preferred visual is ditherable.
+
+
+<!-- ##### FUNCTION gdk_rgb_colormap_ditherable ##### -->
+<para>
+Determines whether the visual associated with @cmap is ditherable. This 
+function may be useful for presenting a user interface choice to the user 
+about which dither mode is desired; if the display is not ditherable, it may 
+make sense to gray out or hide the corresponding UI widget.
+</para>
+
+@cmap: a #GdkColormap 
+@Returns: %TRUE if the visual associated with @cmap is ditherable.
 
 
 <!-- ##### FUNCTION gdk_rgb_set_verbose ##### -->